plug/socket: Clarify docs about availablility of widgets
authorBenjamin Otte <otte@redhat.com>
Fri, 28 Jan 2011 09:56:40 +0000 (10:56 +0100)
committerBenjamin Otte <otte@redhat.com>
Fri, 28 Jan 2011 16:06:06 +0000 (17:06 +0100)
gtk/gtkplug.c
gtk/gtksocket.c

index 8fbcfbd820cd48c188f3bef648f0abafd0902ab4..512d234b1236e212ade6db428ccc9019a68d41af 100644 (file)
  * Any widgets contained in the #GtkPlug then will appear
  * inside the first application's window.
  *
+ * The communication between a #GtkSocket and a #GtkPlug follows the
+ * <ulink url="http://www.freedesktop.org/Standards/xembed-spec">XEmbed</ulink>
+ * protocol. This protocol has also been implemented in other toolkits, e.g.
+ * <application>Qt</application>, allowing the same level of integration
+ * when embedding a <application>Qt</application> widget in GTK or vice versa.
+ *
  * <note>
- * The #GtkPlug and #GtkSocket widgets are currently not available
- * on all platforms supported by GTK+.
+ * The #GtkPlug and #GtkSocket widgets are only available when GTK is
+ * compiled for the X11 platform and %GDK_WINDOWING_X11 is defined.
+ * They can only be used on a #GdkX11Display.
  * </note>
  */
 
index 016c6073b40c4151db12b5a0279fcd2d8c490dae..263972de7e7fb012a9621753bcb4624056aa4c5f 100644 (file)
  * when embedding a <application>Qt</application> widget in GTK or vice versa.
  *
  * <note>
- * The #GtkPlug and #GtkSocket widgets are currently not available
- * on all platforms supported by GTK+.
+ * The #GtkPlug and #GtkSocket widgets are only available when GTK is
+ * compiled for the X11 platform and %GDK_WINDOWING_X11 is defined.
+ * They can only be used on a #GdkX11Display.
  * </note>
  */